home *** CD-ROM | disk | FTP | other *** search
/ Aminet 7 / Aminet 7 - August 1995.iso / Aminet / comm / mebbs / mnl010.lha / MN.L010.doc < prev   
Text File  |  1994-11-23  |  7KB  |  164 lines
  1. Name:        MN.L010
  2. Purpose:     Create Chronological Caller Log
  3. Author:      Dick Pope
  4. Date:        November 23, 1994
  5.  
  6.  
  7. Synopsis:
  8. ---------
  9.  
  10. Some sysops and users prefer a useable caller log accessible through the
  11. the BBS.  This program hopefully remedies that need.
  12.  
  13.  
  14. Description:
  15. ------------
  16.  
  17. MN.L010 will read the MEBBSNet log file(s) (MEBBSNETx.LOG) as indicated in
  18. the configuration file.  It will create a file (as specified in the config
  19. file).  This file can be viewed through a menu item using the SHOWFILE
  20. function.  I would suggest that it be run periodically through use of a cron
  21. utility.
  22.  
  23. The MEBBSNet log file is copied to a ram file (RAM:LOGFILE) to minimize
  24. possible contention if users are online.
  25.  
  26.  
  27. Requirements:
  28. -------------
  29.  
  30. A file called MN.L010.cfg (sample included) must be in the ConfigFiles
  31. directory of MEBBSNet.  This can be changed by changing the "cfgpath"
  32. variable near the top of the program.  In addition, you may specify a
  33. different configuration when the program is initiated.  For example:
  34.  
  35.             rx MN.L010 BBS:altcfg.file
  36.  
  37. would invoke this program using "BBS.altcfg.file" as your configuration
  38. file.  This should make it easier to run this program more than once (e.g.,
  39. for each active line).
  40.  
  41. This program calls the AmigaDos copy, sort and delete routines.
  42.  
  43. The MEBBSNet.con file is also accessed.  It accesses the copy in your
  44. MEBBSNet: directory.  This may be changed in the program through a variable
  45. called "conpath" near the top of the program.  The file is accessed to find
  46. the main BBS path (to determine where to find the configuration file) and to
  47. determine the text files path (to provide a default directory for resulting
  48. aller log files).
  49.  
  50. The configuration file allows you to invoke automatic trimming of your log
  51. file.  It  produces a script in your "s:" directory called "TrimFile.scr",
  52. which uses Matt Dillon's TRIMFILE utility.  This script can then be
  53. automatically executed through a cron utility.  The placement and name of
  54. this file is controlled by a variable called "trimfile" near the top of the
  55. program.
  56.  
  57.  
  58. Configuration:
  59. --------------
  60.  
  61. There are 5 parameters that can be set.  These are in a text file using a
  62. key word to identify each.  These are:
  63.  
  64. 1.  Nodes:  Specifies the nodes you wish to be included in the caller log.
  65.     The default is to include Node 1.  If you, for example, wished to
  66.     include nodes 1 and 3, this parameter would be specified as NODES=13.
  67.  
  68. 2.  Caller File:  Output of the program goes to this file.  It is set by
  69.     using the FILE= parameter.  The full path must be specified.  If not
  70.     present, the default is CALLER.TXT in your Text Files directory.  You
  71.     need not specify the extension.  If present, it will be stripped.  The
  72.     default is for an extension of ".txt" for GRAPHICS=NO and for two files,
  73.     one with a ".txt" extension and one with a ".gr1" extension if you
  74.     specify GRAPHICS=YES.
  75.  
  76. 3.  Log Limit:  Specifies the maximum number of days to be used in the
  77.     caller log.  You specify a limit for each node listed in the NODE=
  78.     parameter.  For example, LIMIT=20/30/ given the above NODES= parameter
  79.     would include the most current 20 days for node 1 and the most current
  80.     30 days for node 3.  The limits MUST be separated with a "/".  If there
  81.     is no ending "/", the program will append one automatically.  The
  82.     default limit is 10 days for all nodes.
  83.  
  84. 4.  Trim:  The MEBBSNet log continues to grow indefinitely.  This option
  85.     allows you to create a script to call Matt Dillon's TRIMFILE program
  86.     that is distributed with his implementation of UUCP.  MN.L010 keeps
  87.     track of how many records are needed to meet the limit specified above.
  88.     The script will trim records off the front of the file(s) specified in
  89.     (1) and (3) above to keep it to a manageable size.  This parameter is
  90.     specified using the TRIM= option.  The default is NO.  Specifying YES
  91.     will cause a TRIMFLx.scr script to be placed in your "MEBBSNet:s"
  92.     directory.  One TRIMFL.scr script will be created for each line
  93.     specified in the NODES= parameter.
  94.  
  95. 5.  ANSI Log:  The GRAPHICS= parameter permits you to create standard ASCII
  96.     or ANSI caller log files.  If NO is specified, only an ASCII file is
  97.     produced.  If YES is specified, both an ASCII and an ANSI caller log
  98.     are produced.
  99.  
  100. These parameters may be specified in any order.
  101.  
  102.  
  103. History:
  104. --------
  105.   v4.10  23-Nov-94  Converted for MEBBSNet v0.160
  106.   v4.00  12-Dec-93  Converted to MEBBSNet
  107.   v3.02  21-Nov-92  Modified to handle 5-character baud rates
  108.   v3.00  17-Dec-91  Converted to StarNet.  ANSI option added.
  109.   v2.10  21-Nov-91  Line number added to caller log
  110.   v2.02  13-Nov-91  Conversion to ARexx caused Fidonet calls to not be
  111.                     included, regardless of the FIDO= parameter.  Wazoo name
  112.                     was added.  You may now also specify an alternate
  113.                     configuration file name when the program is invoked.
  114.   v2.01  20-Oct-91  Log entries scrambled because of line noise caused
  115.                     program to fail.  Corrected (hopefully).
  116.   v2.00  07-Oct-91  Converted to ARexx
  117.   v1.32  27-Dec-90  LoTek FidoNet sessions added to log.  In addition, Fido
  118.                     transfers were added as uploads/downloads.
  119.   v1.31  03-Dec-90  v2.08r disables CTRL-C.  ~vp added to correct.
  120.   v1.30  19-Nov-90  Fido session included in log.  Log limit raised to 400.
  121.   v1.24  01-Sep-90  Descriptions for certain uploads were being treated as
  122.                     downloads.  Problem was corrected.
  123.   v1.23  19-Aug-90  For posting of messages, program hunted for the string
  124.                     "POST" and therefore counted "POST-DOWNLOAD DISCONNECT"
  125.                     as if a message were posted.  Problem was corrected.
  126.   v1.22  19-Aug-90  Error on file integrity check record corrected.
  127.                     Error log extended to provide more information.
  128.   v1.21  17-Aug-90  Add page break after daily totals.
  129.   v1.20  15-Aug-90  Automatic trimming of log file added to configuration.
  130.                     First release without compiled code.  AC/Basic is, at
  131.                     best, flaky when running automatically with DCRON.
  132.   v1.10  13-Aug-90  Daily totals of calls, messages, uploads and downloads
  133.                     added.
  134.   v1.03  11-Aug-90  Crashes caused by AC/Basic read of Paragon log file
  135.                     while Paragon attempted a write to the log file
  136.                     corrected by copying log to Ram and running from Ram.
  137.   v1.02  08-Aug-90  Error in print format when # of calls exceeded limit.
  138.   v1.01  05-Aug-90  Error in calculation of time used fixed.  End of file
  139.                     problem corrected to not list last user if still online.
  140.   v1.00  04-Aug-90  Original program completed
  141.  
  142.  
  143. Further Information:
  144. --------------------
  145.  
  146. Contact:
  147.    Dick Pope
  148.    2809 Watson St.
  149.    Opelika, AL 36801
  150.  
  151.    InterNet:  poperic@mail.auburn.edu
  152.    Fidonet:   1:3613/3.0
  153.    BBS:       Sysop, SmorgasBoard
  154.               205-745-3989 (19.2K USR v.32bis terbo)
  155.  
  156.  
  157. Distribution:
  158. -------------
  159.  
  160. This program may be freely redistributed.  This documentation file must
  161. accompany any distribution.
  162.  
  163. Copyright (c) 1990, 1991, 1993, 1994 Richard Pope.  All Rights Reserved.
  164.